org.eclipse.vtp.desktop.projects.core
Interface IVoiceToolsResource

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable

All Known Subinterfaces:

IApplicationDesign, IApplicationFragment, IApplicationFragmentProject, IApplicationProject, IAudioFile, IBusinessObject, IBusinessObjectSet, IDatabase, IDatabaseSet, IDependency, IDependencySet, IGrammarFile, IMediaContainer, IMediaFile, IMediaFilesFolder, IMediaFolder, IMediaProject, IMediaResource, IPromptSet, IVoiceProject, IVoiceToolsDesignProject, IVoiceToolsProject, IWebService, IWebServiceOperation, IWebServicePort, IWebServiceSet, IWebServiceTypeSet

All Known Implementing Classes:

ApplicationDesign, ApplicationFragment, ApplicationFragmentProject, ApplicationProject, AudioFile, BusinessObject, BusinessObjectField, BusinessObjectSet, Database, DatabaseSet, DatabaseTable, DatabaseTableColumn, Dependency, DependencySet, GrammarFile, MediaFile, MediaFilesFolder, MediaFolder, MediaProject, MediaResource, PromptSet, VoiceProject, VoiceResource, VoiceToolsDesignProject, VoiceToolsProject, WebService, WebServiceOperation, WebServicePort, WebServiceSet, WebServiceType, WebServiceTypeSet

public interface IVoiceToolsResource
extends org.eclipse.core.runtime.IAdaptable

This is the base interface for the openVXML project object model. It provides the baseline functions for all resource objects. It also provides a simple change notification event model.

Version:

2.0

Author:

Trip Gilman

Method Summary

void	addRefreshListener(IRefreshListener listener) Adds the provided refresh listener to the list of listeners that will be notified if this resource should be refreshed.
void	deferEvents() Causes all refresh events for this resource to be ingnored until resumeEvents() is called.
java.lang.String	getName()
IVoiceToolsResource	getParent() Returns the parent of this resource.
IVoiceToolsProject	getProject() Returns the top level project object that contains this resource.
void	refresh() Causes a refresh event to be propigated to all listeners for this resource.
void	removeRefreshListener(IRefreshListener listener) Removes the provided refresh listener from the list of listeners that will be notified of refresh events.
void	resumeEvents() Causes refresh events to once again be propigated to this resources listeners after deferEvents() has been called.

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

getName

java.lang.String getName()

Returns:

The name of the resource

getParent

IVoiceToolsResource getParent()

Returns the parent of this resource. If this is a project resource this function returns this.

Returns:

The parent of this resource resource

addRefreshListener

void addRefreshListener(IRefreshListener listener)

Adds the provided refresh listener to the list of listeners that will be notified if this resource should be refreshed.

Parameters:

listener - The listener to add

removeRefreshListener

void removeRefreshListener(IRefreshListener listener)

Removes the provided refresh listener from the list of listeners that will be notified of refresh events.

Parameters:

listener - The listener to remove

deferEvents

void deferEvents()

Causes all refresh events for this resource to be ingnored until resumeEvents() is called.

resumeEvents

void resumeEvents()

Causes refresh events to once again be propigated to this resources listeners after deferEvents() has been called. This will automatically generate a refresh event to ensure any changes to this resource while events were defered are propigated to its listeners.

refresh

void refresh()

Causes a refresh event to be propigated to all listeners for this resource.

getProject

IVoiceToolsProject getProject()

Returns the top level project object that contains this resource.

Returns:

The containing project